BOT UX API

(0 reviews)

Get ServiceProblem

/serviceProblem [GET]

This operation list or find serviceProblem entities. Attribute selection is enabled for all first level attributes.

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL

http://[host]:[port]/bot-ux/{version}/{businessId}/serviceProblem

URI Parameter

Name	Type	Description	required
businessId	string	2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit.	Y

Query Parameter

Name	Type	Description	required
relatedParty.id	string	Account number	Y

Headers

Name	Type	Description	required
X-Correlation-ID	string	This is a unique identifier for the current call chain that can be used to tie together log entries on multiple layers.`</br>`Example: 644e1dd7-2a7f-18fb-b8ed-ed78c3F92c2b `</br>`	Y
lob	String	TheLine of Business Identifier currently available are:`<br>`Enum: PREPAID , POSTPAID, FIXED`<br>`	Y

Security Headers

Name	Type	Description	required
client_id	string	The client_id identifying the channel. Minimum characters: 5	Y
client_secret	string	Password associated with the client_id. Minimum characters: 5	Y

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - serviceProblem request processed successfully, response body contains an entity corresponding to the requested resource.

NOTE: All Use Cases are listed and referenced to their examples on Use Case section

[
    {
        "id": "371329",
        "@type": "ServiceProblem",
        "creationDate": "2017-09-19T18:46:28.873Z",
        "description": "Open Outage",
        "status": "Supervisor To Assign",
        "characteristic": [
            {
                "name": "NodeName",
                "value": "SCR03",
                "valueType": "string"
            },
            {
                "name": "IncidentKey",
                "value": "NOC-36672",
                "valueType": "string"
            },
            {
                "name": "TodayCustomerIncidentCount",
                "value": "0",
                "valueType": "string"
            },
            {
                "name": "HasOpenMaintainance",
                "value": false,
                "valueType": "boolean"
            }
        ]
    }
]

Definitions

Each of the response parameters is detailed.

name	type	description	required
id	string	Unique identifier	Y
@type	string	When sub-classing, this defines the sub-class Extensible name.	N
creationDate	DateTime	Time the problem was created.	N
description	string	Free form text describing the Service Problem.	N
status	string	A service problem state type (ServiceProblemStateType). Possible values for the state of the ServiceProblem.	N
characteristic	objectArray	A list of characteristics (Characteristic [*]). Describes a given characteristic of an object or entity through a name/value pair.	N
characteristic.name	string	Name of the characteristic.	N
characteristic.value	Any	The value of the characteristic.	N
characteristic.valueType	string	Data type of the value of the characteristic.	N

Possible error response

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
"errors": [{
    "code": 400,
    "message": "APIKIT:BAD_REQUEST",
    "description": "Required header 'client_id' not specified"
    }]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }]
}

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
    "errors": [
        {
            "code": 404,
            "message": "NOTFOUND",
            "description": "NOTFOUND"
        }
    ]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
        "code": 405,
        "message": "APIKIT:METHOD_NOT_ALLOWED",
        "description": "HTTP Method post not allowed for : /{businessId}/serviceProblem"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "The request failed due to an internal error.",
      "description": "error description"
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
    "errors": [{
        "code": 501,
        "message": 'NOT IMPLEMENTED',
        "description": "Operation Get /serviceProblem for BusinessId: JM not implemented"
    }]
}

[ 503 ]

Service Unavailable

{
    "errors": [{
        "code": 503,
        "message": "HTTP:SERVICE_UNAVAILABLE",
        "description": "HTTP GET on resource 'http://0.0.0.0:9091/tmf-api/serviceProblemManagement/v4/PR/serviceProblem' failed: service unavailable (503)."
        }]
}

Reviews